Enhance activate function to return early if workspace root is not found #1038

axewilledge · 2025-12-02T08:16:13Z

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.
$Subject

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email [email protected] to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

UI Component Development

Specify the reason if following are not followed.

Added reusable UI components to the ui-toolkit. Follow the intructions when adding the componenent.
Use ui-toolkit components wherever possible. Run npm run storybook from the root directory to view current components.
Matches with the native VSCode look and feel.

Manage Icons

Specify the reason if following are not followed.

Added Icons to the font-wso2-vscode. Follow the instructions.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

Bug Fixes
- Improved error handling in the test explorer to gracefully handle cases where no workspace is defined, preventing potential runtime issues and crashes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-02T08:16:37Z

Walkthrough

An early-return guard was added to the activate() function in the test-explorer activator to check if workspaceRoot is falsy. This prevents subsequent code from executing when no valid workspace root exists, avoiding potential null/undefined errors in downstream logic.

Changes

Cohort / File(s)	Summary
Test Explorer Activator Guard `workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts`	Added early-return guard to check if `workspaceRoot` is falsy, preventing downstream logic from executing with invalid workspace context

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Verify the guard condition is placed at the correct location in the activation flow
Confirm that the early return prevents all downstream calls that depend on workspaceRoot

Poem

🐰 A guard stands watch at the gate so true,
Catching the empty before work's pursued,
No workspace, no problem—we turn right back,
A simple defense keeps the errors in check! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is mostly empty with only template placeholders and placeholder text ($Subject) instead of actual implementation details, making it incomplete.	Fill in all key template sections with concrete details: Purpose (with issue links), Goals, Approach, test coverage, security checks, and release notes explaining the early return guard change.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding an early return guard in the activate function when workspace root is not found.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts (1)
31-38: Consider moving testController creation after the workspaceRoot guard.

The early return guard correctly prevents downstream null/undefined errors. However, testController is created before checking workspaceRoot. If workspaceRoot is falsy:

testController is initialized but never fully configured (no profiles, file watcher, or discovery)

Since testController is exported, other modules may access a partially initialized controller

The controller is not registered with context.subscriptions for proper disposal

Apply this diff to create the controller only when needed:
 export async function activate(ballerinaExtInstance: BallerinaExtension) {
-    testController = tests.createTestController('ballerina-integrator-tests', 'WSO2 Integrator: BI Tests');
-
     const workspaceRoot = getWorkspaceRoot();
 
     if (!workspaceRoot) {
         return;
     }
+
+    testController = tests.createTestController('ballerina-integrator-tests', 'WSO2 Integrator: BI Tests');

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a333bcf and 25c3ca3.

📒 Files selected for processing (1)

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts (2 hunks)

🧰 Additional context used

🧠 Learnings (9)

📓 Common learnings

Learnt from: KCSAbeywickrama
Repo: wso2/vscode-extensions PR: 653
File: workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts:136-141
Timestamp: 2025-11-26T07:49:56.428Z
Learning: In workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts, the goPrevViewBackButton() method is only called when in a focused view, ensuring breadcrumbs are always present. No guard for empty breadcrumbs is needed.

Learnt from: KCSAbeywickrama
Repo: wso2/vscode-extensions PR: 653
File: workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts:128-134
Timestamp: 2025-11-26T06:34:09.752Z
Learning: In workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts, the goPrevViewBreadcrumb() method is only called when in a focused view, ensuring breadcrumbs are always present. No guard for empty breadcrumbs is needed.

Learnt from: KCSAbeywickrama
Repo: wso2/vscode-extensions PR: 653
File: workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts:86-112
Timestamp: 2025-11-26T06:33:22.950Z
Learning: In workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts, empty catch blocks around progress ring waitForSelector calls (state: 'attached' and 'detached') are intentional. The progress ring duration depends on machine performance and may appear very briefly, causing the wait to miss the event. The try-catch allows the test to proceed gracefully regardless of timing.

📚 Learning: 2025-11-26T07:49:56.428Z

Learnt from: KCSAbeywickrama
Repo: wso2/vscode-extensions PR: 653
File: workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts:136-141
Timestamp: 2025-11-26T07:49:56.428Z
Learning: In workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts, the goPrevViewBackButton() method is only called when in a focused view, ensuring breadcrumbs are always present. No guard for empty breadcrumbs is needed.

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-26T06:34:09.752Z

Learnt from: KCSAbeywickrama
Repo: wso2/vscode-extensions PR: 653
File: workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts:128-134
Timestamp: 2025-11-26T06:34:09.752Z
Learning: In workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts, the goPrevViewBreadcrumb() method is only called when in a focused view, ensuring breadcrumbs are always present. No guard for empty breadcrumbs is needed.

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-05T10:31:47.583Z

Learnt from: madushajg
Repo: wso2/vscode-extensions PR: 830
File: workspaces/ballerina/ballerina-extension/test/ai/post_proccess/post.test.ts:0-0
Timestamp: 2025-11-05T10:31:47.583Z
Learning: In the workspaces/ballerina/ballerina-extension project, the tsconfig.json uses "rootDirs": ["src", "test"], which allows test files to import from src using shorter relative paths. For example, from test/ai/post_proccess/, the import '../../stateMachine' correctly resolves to src/stateMachine.ts due to this configuration.

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-25T06:34:10.812Z

Learnt from: CR
Repo: wso2/vscode-extensions PR: 0
File: workspaces/ballerina/component-diagram/AGENTS.md:0-0
Timestamp: 2025-11-25T06:34:10.812Z
Learning: Applies to workspaces/ballerina/component-diagram/**/*.config.{js,ts} : Use minimatch-compatible glob patterns for file matching in build and test configuration files

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-26T06:33:22.950Z

Learnt from: KCSAbeywickrama
Repo: wso2/vscode-extensions PR: 653
File: workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts:86-112
Timestamp: 2025-11-26T06:33:22.950Z
Learning: In workspaces/bi/bi-extension/src/test/e2e-playwright-tests/data-mapper/DataMapperUtils.ts, empty catch blocks around progress ring waitForSelector calls (state: 'attached' and 'detached') are intentional. The progress ring duration depends on machine performance and may appear very briefly, causing the wait to miss the event. The try-catch allows the test to proceed gracefully regardless of timing.

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-10T15:05:11.309Z

Learnt from: madushajg
Repo: wso2/vscode-extensions PR: 868
File: workspaces/bi/bi-extension/src/utils.ts:224-242
Timestamp: 2025-11-10T15:05:11.309Z
Learning: The workspaces/bi/bi-extension and workspaces/ballerina/ballerina-extension are separate VS Code extensions that are packaged and distributed independently, so they cannot share code via imports and must maintain their own implementations of common utilities.

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-10T15:04:50.474Z

Learnt from: madushajg
Repo: wso2/vscode-extensions PR: 868
File: workspaces/bi/bi-extension/src/utils.ts:153-169
Timestamp: 2025-11-10T15:04:50.474Z
Learning: The workspaces/bi/bi-extension and workspaces/ballerina/ballerina-extension are separate, independently deployable VSCode extensions in the wso2/vscode-extensions repository. Code duplication between these extensions is acceptable and often necessary to maintain their independence, rather than creating cross-extension dependencies.

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

📚 Learning: 2025-11-25T06:34:10.812Z

Learnt from: CR
Repo: wso2/vscode-extensions PR: 0
File: workspaces/ballerina/component-diagram/AGENTS.md:0-0
Timestamp: 2025-11-25T06:34:10.812Z
Learning: Applies to workspaces/ballerina/component-diagram/src/**/*.test.{ts,tsx} : Create snapshot tests for all node widgets and verify visual consistency across renders

Applied to files:

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts

🔇 Additional comments (2)

workspaces/ballerina/ballerina-extension/src/features/test-explorer/activator.ts (2)

40-47: LGTM!

The workspace validation logic is sound. The early return guard at line 36 ensures Uri.file(workspaceRoot) is safe, and the subsequent checks appropriately limit activation to valid Ballerina workspace contexts.

49-68: LGTM!

The test controller setup is comprehensive and correct. Test profiles, file watcher handlers, initial discovery, and lifecycle management via context.subscriptions are all properly configured.

Enhance activate function to return early if workspace root is not found

25c3ca3

axewilledge requested review from gigara and hevayo as code owners December 2, 2025 08:16

coderabbitai bot reviewed Dec 2, 2025

View reviewed changes

kanushka approved these changes Dec 3, 2025

View reviewed changes

Merge branch 'main' into multi-project

633b0f8

kanushka merged commit dcadaff into wso2:main Dec 3, 2025
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enhance activate function to return early if workspace root is not found #1038

Enhance activate function to return early if workspace root is not found #1038

Uh oh!

axewilledge commented Dec 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 2, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Enhance activate function to return early if workspace root is not found #1038

Enhance activate function to return early if workspace root is not found #1038

Uh oh!

Conversation

axewilledge commented Dec 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Goals

Approach

UI Component Development

Manage Icons

User stories

Release note

Documentation

Training

Certification

Marketing

Automation tests

Security checks

Samples

Related PRs

Migrations (if applicable)

Test environment

Learning

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

axewilledge commented Dec 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 2, 2025 •

edited

Loading